docs: fix stale heading-id + footnote facts (clarity audit) - #193
Merged
Conversation
A docs-wide clarity pass turned up factual drift between the case-study narrative and the current grammar/corpus: - case-study/syntax.md (heading ids): the algorithm + examples said ids are NFC-normalized and lowercased by default and "deliberately diverge from djot". The grammar (PART 9, jgm/djot#393) and corpus are the opposite: ids are CASE-PRESERVING with NO Unicode normalization, cross-refs resolve case-insensitively, and lowercasing is an opt-in transform. Rewrite the steps, the example table (Getting-Started, Café-Crème, Über-uns, s-2024-Recap, …), and the framing to match. (comparison.md / divergence-from-djot.md were already correct; syntax.md was the lone stale holdout.) - extensions.md: the footnote note implied inline footnotes are deferred. Inline `^[content]` is implemented Tier-1 core; only the sidenote `[>content]` form is deferred. Clarify. - native-features-analysis.md: label inline footnotes Tier-1 core (a carve addition), not "extension".
dereuromark
added a commit
that referenced
this pull request
Jun 27, 2026
A docs-wide clarity pass turned up factual drift between the case-study narrative and the current grammar/corpus: - case-study/syntax.md (heading ids): the algorithm + examples said ids are NFC-normalized and lowercased by default and "deliberately diverge from djot". The grammar (PART 9, jgm/djot#393) and corpus are the opposite: ids are CASE-PRESERVING with NO Unicode normalization, cross-refs resolve case-insensitively, and lowercasing is an opt-in transform. Rewrite the steps, the example table (Getting-Started, Café-Crème, Über-uns, s-2024-Recap, …), and the framing to match. (comparison.md / divergence-from-djot.md were already correct; syntax.md was the lone stale holdout.) - extensions.md: the footnote note implied inline footnotes are deferred. Inline `^[content]` is implemented Tier-1 core; only the sidenote `[>content]` form is deferred. Clarify. - native-features-analysis.md: label inline footnotes Tier-1 core (a carve addition), not "extension".
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
From a full-docs clarity pass (3 parallel audits). Fixes the factual drift the audit found and I verified against the grammar + corpus:
^[content]is implemented Tier-1 core; only the sidenote[>content]form is deferred.Doc-only;
docs:buildpasses. Verified the audit's other 'stale' flags were false (e.g.:emoji:parsing IS core + corpus-pinned).